Class AppWindowImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.AppWindowImpl
All Implemented Interfaces:
IPCObject, AppWindow

public class AppWindowImpl extends IPCObjectImpl implements AppWindow
Information provided by the PKI file:

    \class AppWindow
    
    \brief AppWindow serves as the entry point to all GUI objects.
    
    \example appWindow()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getMenuBar

      public MenuBar getMenuBar()
      Information provided by the PKI file:
      
          \brief Returns the menu bar.
          
          \return MenuBar, the menu bar widget.
          
              
      Specified by:
      getMenuBar in interface AppWindow
      Returns:
      MenuBar Returns a MenuBar
    • getToolBar

      public ToolBar getToolBar()
      Information provided by the PKI file:
      
          \brief Returns the toolbar.
          
          \return ToolBar, the toolbar widget.
          
              
      Specified by:
      getToolBar in interface AppWindow
      Returns:
      ToolBar Returns a ToolBar
    • getSecondaryToolBar

      public ToolBar getSecondaryToolBar()
      Information provided by the PKI file:
      
          \brief Returns the secondary toolbar.
          
          \return ToolBar, the toolbar widget.
          
              
      Specified by:
      getSecondaryToolBar in interface AppWindow
      Returns:
      ToolBar Returns a ToolBar
    • getRSSwitch

      public RSSwitch getRSSwitch()
      Information provided by the PKI file:
      
          \brief Returns the Realtime/Simulation mode switch.
          
          \return RSSwitch, the Realtime/Simulation mode switch widget.
          
              
      Specified by:
      getRSSwitch in interface AppWindow
      Returns:
      RSSwitch Returns a RSSwitch
    • getPLSwitch

      public PLSwitch getPLSwitch()
      Information provided by the PKI file:
      
          \brief Returns the Physical/Logical workspace switch.
          
          \return PLSwitch, the Physical/Logical workspace switch widget.
          
              
      Specified by:
      getPLSwitch in interface AppWindow
      Returns:
      PLSwitch Returns a PLSwitch
    • getLogicalToolbar

      public LogicalToolbar getLogicalToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Logical workspace toolbar.
          
          \return LogicalToolbar, the Logical workspace toolbar widget.
          
              
      Specified by:
      getLogicalToolbar in interface AppWindow
      Returns:
      LogicalToolbar Returns a LogicalToolbar
    • getPhysicalToolbar

      public PhysicalToolbar getPhysicalToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Physical workspace toolbar.
          
          \return PhysicalToolbar, the Physical workspace toolbar widget.
          
              
      Specified by:
      getPhysicalToolbar in interface AppWindow
      Returns:
      PhysicalToolbar Returns a PhysicalToolbar
    • getSimulationToolbar

      public SimulationToolbar getSimulationToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Simulation mode toolbar.
          
          \return SimulationToolbar, the Simulation mode toolbar widget.
          
              
      Specified by:
      getSimulationToolbar in interface AppWindow
      Returns:
      SimulationToolbar Returns a SimulationToolbar
    • getRealtimeToolbar

      public RealtimeToolbar getRealtimeToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Realtime mode toolbar.
          
          \return RealtimeToolbar, the Realtime mode toolbar widget.
          
              
      Specified by:
      getRealtimeToolbar in interface AppWindow
      Returns:
      RealtimeToolbar Returns a RealtimeToolbar
    • setPLFrameVisible

      public void setPLFrameVisible()
      Specified by:
      setPLFrameVisible in interface AppWindow
    • setRSFrameVisible

      public void setRSFrameVisible()
      Specified by:
      setRSFrameVisible in interface AppWindow
    • getPhysicalLocationDialog

      public PhysicalLocationDialog getPhysicalLocationDialog()
      Information provided by the PKI file:
      
          \brief Returns the Physical Location dialog.
          
          \return PhysicalLocationDialog, the Physical Location dialog widget.
          
              
      Specified by:
      getPhysicalLocationDialog in interface AppWindow
      Returns:
      PhysicalLocationDialog Returns a PhysicalLocationDialog
    • getSimulationPanel

      public SimulationPanel getSimulationPanel()
      Information provided by the PKI file:
      
          \brief Returns the Simulation panel.
          
          \return SimulationPanel, the Simulation panel widget.
          
              
      Specified by:
      getSimulationPanel in interface AppWindow
      Returns:
      SimulationPanel Returns a SimulationPanel
    • getUserCreatedPDU

      public UserCreatedPDU getUserCreatedPDU()
      Information provided by the PKI file:
      
          \brief Returns the User Created PDU.
          
          \return UserCreatedPDU, the User Created PDU widget.
          
              
      Specified by:
      getUserCreatedPDU in interface AppWindow
      Returns:
      UserCreatedPDU Returns a UserCreatedPDU
    • getNetworkComponentBox

      public NetworkComponentBox getNetworkComponentBox()
      Information provided by the PKI file:
      
          \brief Returns the Network Component Box.
          
          \return NetworkComponentBox, the NetworkComponentBox widget.
          
              
      Specified by:
      getNetworkComponentBox in interface AppWindow
      Returns:
      NetworkComponentBox Returns a NetworkComponentBox
    • getPDUListWindow

      public PDUListWindow getPDUListWindow()
      Information provided by the PKI file:
      
          \brief Returns the PDU list window.
          
          \return PDUListWindow, the PDU List Window widget.
          
              
      Specified by:
      getPDUListWindow in interface AppWindow
      Returns:
      PDUListWindow Returns a PDUListWindow
    • getActivityWizard

      public ActivityWizard getActivityWizard()
      Information provided by the PKI file:
      
          \brief Returns the Activity Wizard.
          
          \return ActivityWizard, the Activity Wizard widget.
          
              
      Specified by:
      getActivityWizard in interface AppWindow
      Returns:
      ActivityWizard Returns a ActivityWizard
    • getInfoDialog

      public InfoDialog getInfoDialog()
      Information provided by the PKI file:
      
          \brief Returns the info dialog.
          
          \return InfoDialog, the Info Dialog widget.
          
              
      Specified by:
      getInfoDialog in interface AppWindow
      Returns:
      InfoDialog Returns a InfoDialog
    • getCommonToolbar

      public CommonToolbar getCommonToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Common Toolbar.
          
          \return InfoDialog, the Common Toolbar widget.
          
              
      Specified by:
      getCommonToolbar in interface AppWindow
      Returns:
      CommonToolbar Returns a CommonToolbar
    • isSimulationMode

      public boolean isSimulationMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Simulation mode, otherwise false.
          
          \return bool, true if currently in Simulation mode, otherwise false.
          
              
      Specified by:
      isSimulationMode in interface AppWindow
      Returns:
      boolean Returns a boolean
    • isRealtimeMode

      public boolean isRealtimeMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Realtime mode, otherwise false.
          
          \return bool, true if currently in Realtime mode, otherwise false.
          
              
      Specified by:
      isRealtimeMode in interface AppWindow
      Returns:
      boolean Returns a boolean
    • isLogicalMode

      public boolean isLogicalMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Logical workspace, otherwise false.
          
          \return bool, true if currently in Logical workspace, otherwise false.
          
              
      Specified by:
      isLogicalMode in interface AppWindow
      Returns:
      boolean Returns a boolean
    • isPhysicalMode

      public boolean isPhysicalMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Physical workspace, otherwise false.
          
          \return bool, true if currently in Physical workspace, otherwise false.
          
              
      Specified by:
      isPhysicalMode in interface AppWindow
      Returns:
      boolean Returns a boolean
    • getActiveWorkspace

      public Workspace getActiveWorkspace()
      Information provided by the PKI file:
      
          \brief Returns the current active workspace.
          
          \return Workspace, the current active workspace.
          
              
      Specified by:
      getActiveWorkspace in interface AppWindow
      Returns:
      Workspace Returns a Workspace
    • getActiveDialog

      public ActiveDialog getActiveDialog()
      Information provided by the PKI file:
      
          \brief Returns the current active dialog.
          
          \return ActiveDialog, the current active dialog.
          
              
      Specified by:
      getActiveDialog in interface AppWindow
      Returns:
      ActiveDialog Returns a ActiveDialog
    • getAdminDialog

      public AdministrativeDialog getAdminDialog()
      Information provided by the PKI file:
      
          \brief Returns the administrative dialog.
          
          \return AdministrativeDialog, the administrative dialog widget.
          
              
      Specified by:
      getAdminDialog in interface AppWindow
      Returns:
      AdministrativeDialog Returns a AdministrativeDialog
    • getPaletteDialog

      public PaletteDialog getPaletteDialog()
      Information provided by the PKI file:
      
          \brief Returns the palette dialog.
          
          \return PaletteDialog, the palette dialog widget.
          
              
      Specified by:
      getPaletteDialog in interface AppWindow
      Returns:
      PaletteDialog Returns a PaletteDialog
    • getPrintDialog

      public PrintDialogPT4 getPrintDialog()
      Information provided by the PKI file:
      
          \brief Returns the print dialog.
          
          \return PrintDialogPT4, the print dialog widget.
          
              
      Specified by:
      getPrintDialog in interface AppWindow
      Returns:
      PrintDialogPT4 Returns a PrintDialogPT4
    • getInstructionDlg

      public InstructionDlg getInstructionDlg()
      Information provided by the PKI file:
      
          \brief Returns the activity instructions dialog.
          
          \return InstructionDlg, the activity instructions dialog widget.
          
              
      Specified by:
      getInstructionDlg in interface AppWindow
      Returns:
      InstructionDlg Returns a InstructionDlg
    • suppressInstructionDlg

      public void suppressInstructionDlg(boolean bSuppress)
      Specified by:
      suppressInstructionDlg in interface AppWindow
      Parameters:
      bSuppress - Takes in a parameter of bSuppress
    • getWebViewManager

      public WebViewManager getWebViewManager()
      Information provided by the PKI file:
      
          \brief Returns the WebView manager.
          
          \return WebViewManager, the WebView manager.
          
              
      Specified by:
      getWebViewManager in interface AppWindow
      Returns:
      WebViewManager Returns a WebViewManager
    • getActiveFile

      public NetworkFile getActiveFile()
      Information provided by the PKI file:
      
          \brief Returns the current active file.
          
          \return NetworkFile, the current active file.
          
              
      Specified by:
      getActiveFile in interface AppWindow
      Returns:
      NetworkFile Returns a NetworkFile
    • exit

      public void exit()
      Information provided by the PKI file:
      
          \brief Exits Packet Tracer.
          
              
      Specified by:
      exit in interface AppWindow
    • exitNoConfirm

      public void exitNoConfirm(boolean flag)
      Information provided by the PKI file:
      
          \brief Exits packet tracer with or without save conformation.
          
          \param flag, true to exit Packet Tracer without save confirmation, false to exit with save confirmation.
          
              
      Specified by:
      exitNoConfirm in interface AppWindow
      Parameters:
      flag - Takes in a parameter of flag
    • getDialogManager

      public DialogManager getDialogManager()
      Information provided by the PKI file:
      
          \brief Returns the dialog manager.
          
          \return DialogManager, the dialog manager.
          
              
      Specified by:
      getDialogManager in interface AppWindow
      Returns:
      DialogManager Returns a DialogManager
    • writeToPT

      public void writeToPT(String msg)
      Information provided by the PKI file:
      
          \brief Writes a message to the IPC Log and shows it.
          
          \param msg, the message to write to the IPC Log.
          
              
      Specified by:
      writeToPT in interface AppWindow
      Parameters:
      msg - Takes in a parameter of msg
    • getVersion

      public String getVersion()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer version number.
          
          \remark     The version includes the major, minor, maintainance
          and possibly build numbers.
          
          \return QString, the Packet Tracer version number.
          
              
      Specified by:
      getVersion in interface AppWindow
      Returns:
      String Returns a String
    • getBasePath

      public String getBasePath()
      Information provided by the PKI file:
      
          \brief Returns the installation directory of Packet Tracer.
          
          \return QString, the installation directory of Packet Tracer.
          
              
      Specified by:
      getBasePath in interface AppWindow
      Returns:
      String Returns a String
    • fileNew

      public boolean fileNew(boolean flag)
      Information provided by the PKI file:
      
          \brief Creates a new file.
          
          \param flag, true shows the save confirmation dialog, false does not.
          
          \return bool, true if a new file was created, otherwise false.
          
              
      Specified by:
      fileNew in interface AppWindow
      Parameters:
      flag - Takes in a parameter of flag
      Returns:
      boolean Returns a boolean
    • fileOpen

      public FileOpenReturnValue fileOpen(String filename)
      Information provided by the PKI file:
      
          \brief Opens the specified file.
          
          \param filename, the path of the file.
          
          \return EFileOpenReturnValue
          Can be of the following values:
          eFileReturnOk,
          eFileReturnBadSSL,
          eFileReturnBadDecompress,
          eFileReturnBadBinary,
          eFileReturnBadMetafile,
          eFileReturnBadConfiguration,
          eFileReturnUnableToReadFile,
          eFileReturnBadOptions,
          eFileReturnUserCancel
          
              
      Specified by:
      fileOpen in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • promptFileOpenFolder

      public FileOpenReturnValue promptFileOpenFolder(String folder)
      Information provided by the PKI file:
      
          \brief Prompts to browse a folder for a file to open.
          
          \param folder, the path of the folder to browse.
          
          \return EFileOpenReturnValue
          Can be of the following values:
          eFileReturnOk,
          eFileReturnBadSSL,
          eFileReturnBadDecompress,
          eFileReturnBadBinary,
          eFileReturnBadMetafile,
          eFileReturnBadConfiguration,
          eFileReturnUnableToReadFile,
          eFileReturnBadOptions,
          eFileReturnUserCancel
          
              
      Specified by:
      promptFileOpenFolder in interface AppWindow
      Parameters:
      folder - Takes in a parameter of folder
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • getListOfFilesToOpen

      public List<String> getListOfFilesToOpen(String location)
      Information provided by the PKI file:
      
          \brief Retrives list of files that can be opened location.
          \param location, Reserved
          \return List of files that can be opened.
          
              
      Specified by:
      getListOfFilesToOpen in interface AppWindow
      Parameters:
      location - Takes in a parameter of location
      Returns:
      List<String> Returns a List<String>
    • getListOfFilesSaved

      public List<String> getListOfFilesSaved(String location)
      Information provided by the PKI file:
      
          \brief Retrives list of files saved at default location.
          \param location, Reserved
          \return List of files that can be opened.
          
              
      Specified by:
      getListOfFilesSaved in interface AppWindow
      Parameters:
      location - Takes in a parameter of location
      Returns:
      List<String> Returns a List<String>
    • getDefaultFileSaveLocation

      public String getDefaultFileSaveLocation()
      Information provided by the PKI file:
      
          \brief Retrives default save location
          \return Returns default save location
          
              
      Specified by:
      getDefaultFileSaveLocation in interface AppWindow
      Returns:
      String Returns a String
    • getTempFileLocation

      public String getTempFileLocation()
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsync() and register to fileSaveDone() event.
          
              
      Specified by:
      getTempFileLocation in interface AppWindow
      Returns:
      String Returns a String
    • fileSave

      public boolean fileSave()
      Specified by:
      fileSave in interface AppWindow
      Returns:
      boolean Returns a boolean
    • fileSaveAsync

      public void fileSaveAsync()
      Information provided by the PKI file:
      
          \brief Starts save operation and returns immediately.
          
          \remark Register to fileSaveDone() event to get the status.
          
              
      Specified by:
      fileSaveAsync in interface AppWindow
    • fileSaveAs

      public boolean fileSaveAs(String filename)
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsAsync() and register to fileSaveDone() event.
          
              
      Specified by:
      fileSaveAs in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      boolean Returns a boolean
    • fileSaveAsAsync

      public void fileSaveAsAsync(String filename)
      Information provided by the PKI file:
      
          \brief Starts save as operation to the specified file and returns immediately.
          
          \param filename, the path of the file.
          
          \remark Register to fileSaveDone() event to get the status.
          
              
      Specified by:
      fileSaveAsAsync in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
    • fileSaveAsNoPrompt

      public void fileSaveAsNoPrompt(String filename, boolean bAsync)
      Information provided by the PKI file:
      
          \brief Same as fileSaveAs() except it does not prompt to overwrite the file
          
          \param filename, the path of the file.
          
          \param bAsync, set to true to use fileSaveAsAsync()
          
          \remark Register to fileSaveDone() event to get the status.
          
              
      Specified by:
      fileSaveAsNoPrompt in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
      bAsync - Takes in a parameter of bAsync
    • fileSaveAsPkz

      public boolean fileSaveAsPkz(String filename)
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsPkzAsync() and register to fileSaveDone() event.
          
              
      Specified by:
      fileSaveAsPkz in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      boolean Returns a boolean
    • fileSaveAsPkzAsync

      public void fileSaveAsPkzAsync(String filename)
      Information provided by the PKI file:
      
          \brief Starts save as pkz operation and returns immediately.
          
          \param filename, the path of the file.
          
          \remark Register to fileSaveDone() to get the status.
          
              
      Specified by:
      fileSaveAsPkzAsync in interface AppWindow
      Parameters:
      filename - Takes in a parameter of filename
    • fileActivityWizard

      public void fileActivityWizard()
      Information provided by the PKI file:
      
          \brief Enters the Activity Wizard.
          
              
      Specified by:
      fileActivityWizard in interface AppWindow
    • fileOpenFromURL

      public FileOpenReturnValue fileOpenFromURL(String url)
      Information provided by the PKI file:
      
          \brief Opens a file at the specified URL.
          
          \param url, the URL of the file.
          
          \return bool, true if the file was opened, otherwise false.
          
              
      Specified by:
      fileOpenFromURL in interface AppWindow
      Parameters:
      url - Takes in a parameter of url
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • fileSaveToBytes

      public List<Byte> fileSaveToBytes()
      Information provided by the PKI file:
      
          \deprecated Use fileSaveToBytesAsync() and register to fileSaveToBytesDone().
          
              
      Specified by:
      fileSaveToBytes in interface AppWindow
      Returns:
      List<Byte> Returns a List<Byte>
    • fileSaveToBytesAsync

      public void fileSaveToBytesAsync()
      Information provided by the PKI file:
      
          \brief Starts save to bytes operation and returns immediately.
          
          \remark Register to fileSaveToBytesDone() event to get save in bytes.
          
              
      Specified by:
      fileSaveToBytesAsync in interface AppWindow
    • shouldIgnoreFileNew

      public boolean shouldIgnoreFileNew()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->new action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->new action.
          
              
      Specified by:
      shouldIgnoreFileNew in interface AppWindow
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileOpenFolder

      public boolean shouldIgnoreFileOpenFolder(String folder)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->open folder action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg folder, the folder the user wants to browse for files to open.
          
          \return bool, true if PT should ignore the file->open folder action.
          
              
      Specified by:
      shouldIgnoreFileOpenFolder in interface AppWindow
      Parameters:
      folder - Takes in a parameter of folder
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileOpenRecent

      public boolean shouldIgnoreFileOpenRecent(String file)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->open recent file action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg file, the path of the recent file to open.
          
          \return bool, true if PT should ignore the file->open recent file action.
          
              
      Specified by:
      shouldIgnoreFileOpenRecent in interface AppWindow
      Parameters:
      file - Takes in a parameter of file
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileSave

      public boolean shouldIgnoreFileSave()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->save action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->save action.
          
              
      Specified by:
      shouldIgnoreFileSave in interface AppWindow
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileSaveAs

      public boolean shouldIgnoreFileSaveAs(String file)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->save as action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg file, the file to save as
          
          \return bool, true if PT should ignore the file->save as action.
          
              
      Specified by:
      shouldIgnoreFileSaveAs in interface AppWindow
      Parameters:
      file - Takes in a parameter of file
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileExit

      public boolean shouldIgnoreFileExit()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->exit action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->exit action.
          
              
      Specified by:
      shouldIgnoreFileExit in interface AppWindow
      Returns:
      boolean Returns a boolean
    • isPreventClose

      public boolean isPreventClose()
      Information provided by the PKI file:
      
          \brief Returns true if Packet Tracer is prevented from closing, otherwise false.
          
          \return bool, true if Packet Tracer is prevented from closing, otherwise false.
          
              
      Specified by:
      isPreventClose in interface AppWindow
      Returns:
      boolean Returns a boolean
    • setPreventClose

      public void setPreventClose(boolean bPreventClose)
      Information provided by the PKI file:
      
          \brief Allows or prevents Packet Tracer from closing.
          
          \param bPreventClose, true to prevent Packet Tracer from closing, false to allow closing.
          
              
      Specified by:
      setPreventClose in interface AppWindow
      Parameters:
      bPreventClose - Takes in a parameter of bPreventClose
    • getProcessId

      public long getProcessId()
      Information provided by the PKI file:
      
          \brief Returns Packet Tracer application process ID.
          
          \return long, Packet Tracer application process ID.
          
              
      Specified by:
      getProcessId in interface AppWindow
      Returns:
      long Returns a long
    • getSessionId

      public String getSessionId()
      Information provided by the PKI file:
      
          \brief Returns the globally unique Packet Tracer application session ID.
          
          \return QString, the globally unique Packet Tracer application session ID.
          
              
      Specified by:
      getSessionId in interface AppWindow
      Returns:
      String Returns a String
    • getUserFolder

      public String getUserFolder()
      Information provided by the PKI file:
      
          \brief Returns the user folder of the current user logged into the OS.
          
          \return QString, the user folder of the current user logged into the OS.
          
              
      Specified by:
      getUserFolder in interface AppWindow
      Returns:
      String Returns a String
    • setVisible

      public void setVisible(boolean flag)
      Information provided by the PKI file:
      
          \brief This event is emitted when a message box should be displayed.
          \NOT APPLICABLE TO DESKTOP
          event: popupMessage(QString reason, QString title, QString message, QString buttonA, QString buttonB, QString buttonC, QString buttonD) - PrivApplication;
          
          \brief Shows or hides the Packet Tracer main window.
          
          \param flag, true to show the Packet Tracer main window, false to hide it.
          
              
      Specified by:
      setVisible in interface AppWindow
      Parameters:
      flag - Takes in a parameter of flag
    • raise

      public void raise()
      Specified by:
      raise in interface AppWindow
    • setDisabled

      public void setDisabled(boolean flag)
      Information provided by the PKI file:
      
          \brief Disables or enables the application.  Buttons, etc will be shown as disabled and unuable.
          
          \param flag, true to disable the application and false to enable.
          
              
      Specified by:
      setDisabled in interface AppWindow
      Parameters:
      flag - Takes in a parameter of flag
    • isMaximized

      public void isMaximized()
      Information provided by the PKI file:
      
          \brief Returns whether the Packet Tracer main window is maximized.
          
              
      Specified by:
      isMaximized in interface AppWindow
    • showMaximized

      public void showMaximized()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the maximum size.
          
              
      Specified by:
      showMaximized in interface AppWindow
    • isMinimized

      public void isMinimized()
      Information provided by the PKI file:
      
          \brief Returns whether the Packet Tracer main window is minimized.
          
              
      Specified by:
      isMinimized in interface AppWindow
    • showMinimized

      public void showMinimized()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the minimum size.
          
              
      Specified by:
      showMinimized in interface AppWindow
    • showNormal

      public void showNormal()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the normal size.
          
              
      Specified by:
      showNormal in interface AppWindow
    • setWindowTitle

      public void setWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window title.
          
          \param title, the window title
          
              
      Specified by:
      setWindowTitle in interface AppWindow
      Parameters:
      title - Takes in a parameter of title
    • setWindowGeometry

      public void setWindowGeometry(int x, int y, int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window geometry and position.
          
          \param x, the x-coordinate of the main window.
          \param y, the y-coordinate of the main window.
          \param width, the width of the main window.
          \param height, the height of the main window.
          
              
      Specified by:
      setWindowGeometry in interface AppWindow
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getX

      public int getX()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window x-coorindate.
          
          \return int, the Packet Tracer main window x-coorindate.
          
              
      Specified by:
      getX in interface AppWindow
      Returns:
      int Returns a int
    • getY

      public int getY()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window y-coorindate.
          
          \return int, the Packet Tracer main window y-coorindate.
          
              
      Specified by:
      getY in interface AppWindow
      Returns:
      int Returns a int
    • getWidth

      public int getWidth()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window width.
          
          \return int, the Packet Tracer main window width.
          
              
      Specified by:
      getWidth in interface AppWindow
      Returns:
      int Returns a int
    • getHeight

      public int getHeight()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window height.
          
          \return int, the Packet Tracer main window height.
          
              
      Specified by:
      getHeight in interface AppWindow
      Returns:
      int Returns a int
    • setMaximumSize

      public void setMaximumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum size of the Packet Tracer main window.
          
              
      Specified by:
      setMaximumSize in interface AppWindow
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMaximumWidth

      public void setMaximumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the maximum width of the Packet Tracer main window.
          
              
      Specified by:
      setMaximumWidth in interface AppWindow
      Parameters:
      width - Takes in a parameter of width
    • setMaximumHeight

      public void setMaximumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum height of the Packet Tracer main window.
          
              
      Specified by:
      setMaximumHeight in interface AppWindow
      Parameters:
      height - Takes in a parameter of height
    • getMaximumWidth

      public int getMaximumWidth()
      Information provided by the PKI file:
      
          \brief Returns the maximum width of the Packet Tracer main window.
          
              
      Specified by:
      getMaximumWidth in interface AppWindow
      Returns:
      int Returns a int
    • getMaximumHeight

      public int getMaximumHeight()
      Information provided by the PKI file:
      
          \brief Returns the maximum height of the Packet Tracer main window.
          
              
      Specified by:
      getMaximumHeight in interface AppWindow
      Returns:
      int Returns a int
    • setMinimumSize

      public void setMinimumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum size of the Packet Tracer main window.
          
              
      Specified by:
      setMinimumSize in interface AppWindow
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMinimumWidth

      public void setMinimumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the minimum width of the Packet Tracer main window.
          
              
      Specified by:
      setMinimumWidth in interface AppWindow
      Parameters:
      width - Takes in a parameter of width
    • setMinimumHeight

      public void setMinimumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum height of the Packet Tracer main window.
          
              
      Specified by:
      setMinimumHeight in interface AppWindow
      Parameters:
      height - Takes in a parameter of height
    • getMinimumWidth

      public int getMinimumWidth()
      Information provided by the PKI file:
      
          \brief Returns the minimum width of the Packet Tracer main window.
          
              
      Specified by:
      getMinimumWidth in interface AppWindow
      Returns:
      int Returns a int
    • getMinimumHeight

      public int getMinimumHeight()
      Information provided by the PKI file:
      
          \brief Returns the minimum height of the Packet Tracer main window.
          
              
      Specified by:
      getMinimumHeight in interface AppWindow
      Returns:
      int Returns a int
    • getMainViewAreaWidth

      public int getMainViewAreaWidth()
      Information provided by the PKI file:
      
          \brief Returns the main view area's width.
          
          \return int, the main view area's width.
          
              
      Specified by:
      getMainViewAreaWidth in interface AppWindow
      Returns:
      int Returns a int
    • getMainViewAreaHeight

      public int getMainViewAreaHeight()
      Information provided by the PKI file:
      
          \brief Returns the main view area's height.
          
          \return int, the main view area's height.
          
              
      Specified by:
      getMainViewAreaHeight in interface AppWindow
      Returns:
      int Returns a int
    • isInterfaceLocked

      public boolean isInterfaceLocked(String ID, String branchID1, String branchID2)
      Information provided by the PKI file:
      
          \brief Returns true if the interface with the specified ID is locked, otherwise false.
          
          \param ID, the ID of the item to check if locked.
          \param branchID1, limit the search to this branch ID.
          \param branchID2, limit the search to this branch ID of branchID1.
          
          \return bool, true if the interface with the specified ID is locked, otherwise false.
          
              
      Specified by:
      isInterfaceLocked in interface AppWindow
      Parameters:
      ID - Takes in a parameter of ID
      branchID1 - Takes in a parameter of branchID1
      branchID2 - Takes in a parameter of branchID2
      Returns:
      boolean Returns a boolean
    • setClipboardText

      public void setClipboardText(String text)
      Information provided by the PKI file:
      
          \brief Sets the clipboard text(copy/paste text) to the given text.
          
          \param text, text to put on the clipboard to use for paste.
          
              
      Specified by:
      setClipboardText in interface AppWindow
      Parameters:
      text - Takes in a parameter of text
    • getClipboardText

      public String getClipboardText()
      Information provided by the PKI file:
      
          \brief Returns the current clipboard text, if any.
          
          \return QString, text stored in the copy/paste clipboard.
          
              
      Specified by:
      getClipboardText in interface AppWindow
      Returns:
      String Returns a String
    • helpPath

      public void helpPath(String subPath)
      Information provided by the PKI file:
      
          \brief Open a help file at the given path.
          
          \param subPath, subpath to the file to open.
          
              
      Specified by:
      helpPath in interface AppWindow
      Parameters:
      subPath - Takes in a parameter of subPath
    • openURL

      public boolean openURL(String url)
      Information provided by the PKI file:
      
          \brief Open URL in external web browser.
          
          \param url, url to open.
          
              
      Specified by:
      openURL in interface AppWindow
      Parameters:
      url - Takes in a parameter of url
      Returns:
      boolean Returns a boolean
    • getEnvironmentDialog

      public EnvironmentDialog getEnvironmentDialog()
      Information provided by the PKI file:
      
          \brief Returns the Environment Dialog.
          
          \return Environment Dialog
          
              
      Specified by:
      getEnvironmentDialog in interface AppWindow
      Returns:
      EnvironmentDialog Returns a EnvironmentDialog
    • listDirectory

      public List<String> listDirectory(String location, String filter)
      Information provided by the PKI file:
      
          \brief Temporary function used to update sample files.  Not for normal use.
          
              
      Specified by:
      listDirectory in interface AppWindow
      Parameters:
      location - Takes in a parameter of location
      filter - Takes in a parameter of filter
      Returns:
      List<String> Returns a List<String>
    • setCheckOutdatedDevices

      public void setCheckOutdatedDevices(boolean bCheck)
      Information provided by the PKI file:
      
          \brief Set if devices marked as outdated should be displayed for selection.
          
          \param bCheck, true if outdated devices should be handled when setting up the toolbar, false if not.
          
              
      Specified by:
      setCheckOutdatedDevices in interface AppWindow
      Parameters:
      bCheck - Takes in a parameter of bCheck
    • deletePTConf

      public void deletePTConf()
      Specified by:
      deletePTConf in interface AppWindow
    • getPTSAMode

      public String getPTSAMode()
      Information provided by the PKI file:
      
          \brief Get the current PTSA Mode.
          
          \return QString, current PTSA Mode.
          
              
      Specified by:
      getPTSAMode in interface AppWindow
      Returns:
      String Returns a String
    • setPTSAMode

      public void setPTSAMode(String ptsaMode)
      Information provided by the PKI file:
      
          \brief Get the current PTSA Mode.
          
          \return QString, current PTSA Mode.
          
              
      Specified by:
      setPTSAMode in interface AppWindow
      Parameters:
      ptsaMode - Takes in a parameter of ptsaMode
    • isPTSA

      public boolean isPTSA()
      Information provided by the PKI file:
      
          \brief returns true if PTSA
          
          \return bool, true if PTSA.
          
              
      Specified by:
      isPTSA in interface AppWindow
      Returns:
      boolean Returns a boolean
    • setPTSAPluginVisible

      public void setPTSAPluginVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief show and hide pt window, called from ptsa plugin only. you still need to clear other windows, possibly with file->new
          
          \return
          
              
      Specified by:
      setPTSAPluginVisible in interface AppWindow
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • isActivityWizardOpen

      public boolean isActivityWizardOpen()
      Specified by:
      isActivityWizardOpen in interface AppWindow
      Returns:
      boolean Returns a boolean